home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audio / ALgetframetime.z / ALgetframetime
Encoding:
Text File  |  1998-10-20  |  5.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4. AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee((((3333ddddmmmm))))                                        AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ALgetframetime - (obsolete) Get the time at which a sample frame came in
  10.      or will go out
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  14.  
  15.      iiiinnnntttt AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee((((ccccoooonnnnsssstttt AAAALLLLppppoooorrrrtttt ppppoooorrrrtttt,,,, uuuunnnnssssiiiiggggnnnneeeedddd lllloooonnnngggg lllloooonnnngggg ****ffffnnnnuuuummmm,,,, uuuunnnnssssiiiiggggnnnneeeedddd lllloooonnnngggg lllloooonnnngggg ****ttttiiiimmmmeeee))))
  16.  
  17. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  18.      _p_o_r_t expects the AAAALLLLppppoooorrrrtttt structure for the audio port for which you wish
  19.           to know the sample frame number.  This structure is the returned
  20.           value of the AAAALLLLooooppppeeeennnnppppoooorrrrtttt((((3333ddddmmmm)))) call.
  21.  
  22.      _f_n_u_m expects a pointer to an unsigned 64-bit value which is to contain
  23.           the resultant sample-frame number.
  24.  
  25.      _t_i_m_e expects a pointer to an unsigned 64-bit value which is to contain
  26.           the resultant sample-frame time, in nanoseconds.
  27.  
  28. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  29.      AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee is obsolete and is provided for backward compatibility.
  30.      The preferred function is _a_l_G_e_t_F_r_a_m_e_T_i_m_e(_3_d_m).
  31.  
  32.      AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee returns an atomic pair of (fnum, time). For an input port,
  33.      the time returned is the time at which the returned sample frame arrived
  34.      at the electrical input on the machine. For an output port, the time
  35.      returned is the time at which the returned sample frame will arrive at
  36.      the electrical output on the machine. AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee therefore accounts
  37.      for all the latency within the machine, including the group delay of the
  38.      A/D and D/A converters.
  39.  
  40.      The returned sample frame number is not guaranteed to be in any
  41.      application's port. For example, an input sample frame as returned by
  42.      AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee may be "in the future": it has not yet arrived in any
  43.      application's port. Similarly, an output sample frame may be "in the
  44.      past": it has already gone out of some application's port. In order to
  45.      relate the sample frame numbers to those of a particular application's
  46.      audio port, the AAAALLLLggggeeeettttffffrrrraaaammmmeeeennnnuuuummmmbbbbeeeerrrr call must be used.
  47.  
  48.      AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee uses the Unadjusted System Time (UUUUSSSSTTTT) as its timeline.
  49.      This allows it to relate to other media which also use UUUUSSSSTTTT. See the man
  50.      page for ddddmmmmGGGGeeeettttUUUUSSSSTTTT((((3333ddddmmmm)))) for more information on UST.
  51.  
  52.      AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee can fail for the following reasons:
  53.  
  54.      AAAALLLL____BBBBAAAADDDD____PPPPOOOORRRRTTTT
  55.           _p_o_r_t is invalid.
  56.  
  57.      AAAALLLL____BBBBAAAADDDD____NNNNOOOOTTTT____IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTEEEEDDDD
  58.           the feature is not implemented on the given machine. AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee
  59.           is not implemented on Indigo (IP12), 4D/35 (IP12), and Indigo R4K
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee((((3333ddddmmmm))))                                        AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.           (IP20) systems.
  75.  
  76.  
  77. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  78.      Upon successful completion, AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee((((3333ddddmmmm)))) returns 0. Otherwise
  79.      AAAALLLLggggeeeettttffffrrrraaaammmmeeeettttiiiimmmmeeee((((3333ddddmmmm)))) returns -1 and sets an error number which can be
  80.      retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  81.  
  82. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  83.      dmGetUST(3dm), ALgetframenumber(3A), oserror(3C)
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.